<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hardware Abstraction Layer (HAL)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="logo.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Hardware Abstraction Layer (HAL)</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__group__hal.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#groups">API Reference</a>  </div>
  <div class="headertitle"><div class="title">HAL Drivers</div></div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p >This section documents the drivers which form the stable API of the ModusToolbox™ HAL. </p>
<p >In order to remain portable across platforms and HAL versions, applications should rely only on functionality documented in this section. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
API Reference</h2></td></tr>
<tr class="memitem:group__group__hal__adc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__adc.html">ADC (Analog to Digital Converter)</a></td></tr>
<tr class="memdesc:group__group__hal__adc"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the analog to digital converter (ADC). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__clock"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__clock.html">Clock</a></td></tr>
<tr class="memdesc:group__group__hal__clock"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for getting and changing clock configuration. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__comp"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__comp.html">COMP (Analog Comparator)</a></td></tr>
<tr class="memdesc:group__group__hal__comp"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with an analog Comparator. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__crc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__crc.html">CRC (Cyclic Redundancy Check)</a></td></tr>
<tr class="memdesc:group__group__hal__crc"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the CRC, which provides hardware accelerated CRC computations. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__dac"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__dac.html">DAC (Digital to Analog Converter)</a></td></tr>
<tr class="memdesc:group__group__hal__dac"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the digital to analog converter (DAC). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__dma"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__dma.html">DMA (Direct Memory Access)</a></td></tr>
<tr class="memdesc:group__group__hal__dma"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the direct memory access (DMA). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__ezi2c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__ezi2c.html">EZI2C (Inter-Integrated Circuit)</a></td></tr>
<tr class="memdesc:group__group__hal__ezi2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Cypress EZ Inter-Integrated Circuit (EZI2C). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__syspm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__syspm.html">System Power Management</a></td></tr>
<tr class="memdesc:group__group__hal__syspm"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interface for changing power states and restricting when they are allowed. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__gpio"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__gpio.html">GPIO (General Purpose Input Output)</a></td></tr>
<tr class="memdesc:group__group__hal__gpio"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for configuring and interacting with general purpose input/outputs (GPIO). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__hwmgr"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__hwmgr.html">HWMGR (Hardware Manager)</a></td></tr>
<tr class="memdesc:group__group__hal__hwmgr"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface to the Hardware Manager. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__i2c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__i2c.html">I2C (Inter-Integrated Circuit)</a></td></tr>
<tr class="memdesc:group__group__hal__i2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the I2C resource. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__i2s"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__i2s.html">I2S (Inter-IC Sound)</a></td></tr>
<tr class="memdesc:group__group__hal__i2s"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Inter-IC Sound (I2S). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__interconnect"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__interconnect.html">Interconnect (Internal Digital Routing)</a></td></tr>
<tr class="memdesc:group__group__hal__interconnect"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface to the Infineon digital routing. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__ipc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__ipc.html">IPC (Inter-Processor Communication)</a></td></tr>
<tr class="memdesc:group__group__hal__ipc"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for communicating between processors on a multi-core device. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__keyscan"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__keyscan.html">Keyscan</a></td></tr>
<tr class="memdesc:group__group__hal__keyscan"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the KeyScan. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__lptimer"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__lptimer.html">LPTimer (Low-Power Timer)</a></td></tr>
<tr class="memdesc:group__group__hal__lptimer"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the low-power timer (LPTimer). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__nvm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__nvm.html">NVM (Onboard Non-Volatile Memory)</a></td></tr>
<tr class="memdesc:group__group__hal__nvm"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface to the onboard Non-Volatile memory (Internal Flash, RRAM, OTP region). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__opamp"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__opamp.html">Opamp (Operational Amplifier)</a></td></tr>
<tr class="memdesc:group__group__hal__opamp"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Operational Amplifier (Opamp). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__pdmpcm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__pdmpcm.html">PDM/PCM (Pulse-Density Modulation to Pulse-Code Modulation Converter)</a></td></tr>
<tr class="memdesc:group__group__hal__pdmpcm"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the pulse-density modulation to pulse-code modulation (PDM/PCM) converter. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__pwm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__pwm.html">PWM (Pulse Width Modulator)</a></td></tr>
<tr class="memdesc:group__group__hal__pwm"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the pulse width modulator (PWM) hardware resource. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__qspi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__qspi.html">QSPI (Quad Serial Peripheral Interface)</a></td></tr>
<tr class="memdesc:group__group__hal__qspi"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Quad-SPI interface. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__quaddec"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__quaddec.html">Quadrature Decoder</a></td></tr>
<tr class="memdesc:group__group__hal__quaddec"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Quadrature Decoder hardware resource. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__rtc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__rtc.html">RTC (Real-Time Clock)</a></td></tr>
<tr class="memdesc:group__group__hal__rtc"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the real-time clock (RTC). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__sdhc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__sdhc.html">SDHC (SD Host Controller)</a></td></tr>
<tr class="memdesc:group__group__hal__sdhc"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface to the Secure Digital Host Controller (SDHC). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__sdio"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__sdio.html">SDIO (Secure Digital Input Output)</a></td></tr>
<tr class="memdesc:group__group__hal__sdio"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface to the Secure Digital Input Output (SDIO). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__spi"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__spi.html">SPI (Serial Peripheral Interface)</a></td></tr>
<tr class="memdesc:group__group__hal__spi"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Serial Peripheral Interface (SPI). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__system"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__system.html">System</a></td></tr>
<tr class="memdesc:group__group__hal__system"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with reset and delays. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__tdm"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__tdm.html">TDM (Time Division Multiplexed)</a></td></tr>
<tr class="memdesc:group__group__hal__tdm"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Time Division Multiplexed controller (TDM). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__timer"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__timer.html">Timer (Timer/Counter)</a></td></tr>
<tr class="memdesc:group__group__hal__timer"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Timer/Counter hardware resource. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__trng"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__trng.html">TRNG (True Random Number Generator)</a></td></tr>
<tr class="memdesc:group__group__hal__trng"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface to the True Random Number Generator (TRNG). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__uart"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__uart.html">UART (Universal Asynchronous Receiver-Transmitter)</a></td></tr>
<tr class="memdesc:group__group__hal__uart"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the Universal Asynchronous Receiver-Transmitter (UART). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__usb__dev"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__usb__dev.html">USB Device</a></td></tr>
<tr class="memdesc:group__group__hal__usb__dev"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface for interacting with the USB Device. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__group__hal__wdt"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__hal__wdt.html">WDT (Watchdog Timer)</a></td></tr>
<tr class="memdesc:group__group__hal__wdt"><td class="mdescLeft">&#160;</td><td class="mdescRight">High level interface to the Watchdog Timer (WDT). <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>Hardware Abstraction Layer (HAL)</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
